home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / text / print / aprf2_210.lha / Diffusion / APrf / APrfEnglish.doc < prev    next >
Text File  |  1992-12-20  |  37KB  |  951 lines

  1.  
  2. '.
  3.                   APrf2 - User's Guide
  4.  
  5.  
  6.  
  7.  
  8.  
  9. AboutThisDoc
  10.  
  11.       This file describes release 2.10 of the utility APrf2. This  program
  12.   is (c)1989-1990-1991-1992 by Denis GOUNELLE, any commercial usage or selling
  13.   without author's written authorization is strictly forbidden. You  can  copy
  14.   and spread this program at the following conditions:
  15.  
  16.       - all the files must be provided
  17.       - none of the file must have been modified
  18.       - you don't charge more than $6 for copy fee
  19.  
  20.       "PowerPacker 2.3b"  is  (c)1989  by  PowerPeak  and  Nico  FRANCOIS.
  21.   "PowerPacker Pro 3.0b"  is  (c)1990  by  PowerPeak  and  UGA  SoftWare.  The
  22.   "powerpacker.library" library is (c)1990 by Nico FRANCOIS. AREXX is  (c)1987
  23.   by William Hawes. The "reqtools.library" library  is  (c)1990-1991  by  Nico
  24.   FRANCOIS.
  25.  
  26.       No warranty is made that there's no errors in  APrf.  YOU  USE  THIS
  27.   PROGRAM AT YOUR OWN RISKS. In no event will I  be  liable  for  any  damage,
  28.   direct or indirect, resulting of the use of APrf.
  29.  
  30. Introduction
  31.  
  32.       APrf2 is a new version of APrf which can use the  new  functions  of
  33.   2.0 system release. This program still works under 1.3 system  release,  but
  34.   without offering some of the new features.
  35.       APrf is a printing utility, which allows  to    add  an  header  or  a
  36.   footer, to set up margins, to have a multi-columns output, etc...  and  uses
  37.   your Preferences settings. It also have an AREXX-compatible message port, an
  38.   application window (or "AppWindow", under 2.0 system release only)  and  can
  39.   load files compressed with "PowerPacker 2.3b" or "PowerPacker Pro 3.0b".
  40.  
  41.       You can send me your suggestions and criticism writing to:
  42.  
  43.                    M. GOUNELLE Denis
  44.                     Boite 71
  45.                   6, rue des cailloux
  46.                  92110 CLICHY - FRANCE
  47.  
  48.       You can also send a message to  the  following  Internet  address  :
  49.   gounelle@alphanet.ch. Note that this mailbox is not  mine,  so  please  send
  50.   only short messages. As I don't have direct access to  the  messages,  don't
  51.   expect an answer before a dozen of days.
  52.  
  53.       Many thanks to Serge HAMMOUCHE, Jean-Yves PROUX, Jean-Philippe RAPP,
  54.   Jean ROUGELIN, Michel SCHINZ, and Pierre VITET for tests and ideas.
  55.  
  56. Running_from_CLI
  57.  
  58.       There's no need to use a "RunBack" or "ARun" utility, as  APrf  will
  59.   detach itself from the CLI window. The command line is of the form:
  60.  
  61.       APrf [filename][-c#][-f#,#][-l#][-n#][-oF][-p#][-r#][-s#][-t#]
  62.       [-x#][-A][-Cseq][-D#][-F{L|C|R}fmt][-H{L|C|R}fmt][-Ifont]
  63.       [-N#][-Oopts][-P{p|e|f}][-Spages][-X]
  64.  
  65.       If you specify the <filename> argument, the corresponding file  will
  66.   be taken as the file to print. Here's a description of the other  arguments:
  67.  
  68.       -c# (Columns number)
  69.       Prints file in # columns.
  70.       Default value: # = 1
  71.       Minimal value: # = 1. Maximal value: # = 999.
  72.  
  73.       -f#,# (page Format)
  74.       Selects page format and pages where to print    header    and/or
  75.       footer. The first # can be one of:
  76.  
  77.           0   nothing
  78.           1   header
  79.           2   footer
  80.           3   both header and footer
  81.  
  82.       Default value: # = 1.
  83.  
  84.       The second # can be one of:
  85.  
  86.           0   on all pages
  87.           1   on all pages but the first
  88.           2   on even pages
  89.           3   on odd pages
  90.  
  91.       Default value: # = 0.
  92.  
  93.       You can modified only one of    these  parameters  :  "-f1,2",
  94.       "-f1" and "-f,2" forms are accepted.  See  section  2.6  for
  95.       more information.
  96.  
  97.       -l# (Left margin)
  98.       Sets a left margin of # characters. Note  that  the  margins
  99.       set up in Preferences is ALWAYS used.
  100.       Default value: # = 0
  101.       Minimal value: # = 0. Maximal value: # = 999.
  102.  
  103.       -n# (line Numbering)
  104.       Numbers lines with # digits numbers.
  105.       Default value: # = 0 (no line numbers).
  106.       Minimal value: # = 0. Maximal value: # = 10.
  107.  
  108.       -oF (Output)
  109.       Printing will be re-directed to file F.
  110.  
  111.       -p# (Page length)
  112.       Sets page length to # lines.
  113.       Default value: "Paper length" set up in Preferences.
  114.       Minimal value: # = 5. Maximal value: # = 999.
  115.  
  116.       -r# (Right margin)
  117.       Sets a right margin of # characters. Note that  the  margins
  118.       set up in Preferences is ALWAYS used.
  119.       Default value: # = 0
  120.       Minimal value: # = 0. Maximal value: # = 999.
  121.  
  122.       -s# (column Spaging)
  123.       Columns are separated by # spaces.
  124.       Default value: # = 1
  125.       Minimal value: # = 1. Maximal value: # = 999.
  126.  
  127.       -t# (Tabulation)
  128.       Sets tabulation stop positions to #+1, 2#+1, 3#+1, etc..
  129.       Default value: # = 8.
  130.       Minimal value: # = 1. Maximal value: # = 999.
  131.  
  132.       -x# (copies)
  133.       Prints # copies of the file.
  134.       Default value: # = 1
  135.       Minimal value: # = 1. Maximal value: # = 999.
  136.  
  137.       -A (Arexx mode)
  138.       Sets AREXX mode (see section 3.3 for more information).
  139.  
  140.       -Cseq (Control sequence)
  141.       Selects the control sequence "seq" (see section 3.5 for more
  142.       information).
  143.  
  144.       -D# (Date format)
  145.       Sets date format in header. # can be one of:
  146.  
  147.           0   AmigaDOS format (dd-mmm-yy)
  148.           1   International format (yy-mm-dd)
  149.           2   American format (mm-dd-yy)
  150.           3   European format (dd-mm-yy)
  151.  
  152.       Default value: # = 0.
  153.       See section 2.6 for more information.
  154.  
  155.       -F{L|C|R}fmt (Footer format)
  156.       Specifies page footer format.
  157.       See section 2.6 for more information.
  158.  
  159.       -H{L|C|R}fmt (Header format)
  160.       Specifies page header format.
  161.       See section 2.6 for more information.
  162.  
  163.       -Ifont (Internal font)
  164.       Select the given font.
  165.       See section 3.5 for more information.
  166.  
  167.       -N# (page Numbers)
  168.       Sets first page number to #.
  169.       Default value: # = 1.
  170.       Minimal value: # = 1. Maximal value: # = 899.
  171.  
  172.       -Oopts (Options)
  173.       Allows you to modify several    options.  "opts"  can  be  any
  174.       combination of :
  175.  
  176.           l   letter quality
  177.           d   draft quality
  178.           8   8 LPI spacing
  179.           6   6 LPI spacing
  180.           F   fanfold paper
  181.           S   single sheet paper
  182.           t   truncate too long lines
  183.           f   control characters filter
  184.           a   ANSI sequences filter
  185.           k   output buffer size of 1 Kbytes
  186.           n   don't send "Form Feed"
  187.           u   underline header
  188.  
  189.       See the description of "Options" menu, at section  2.5,  for
  190.       further informations.
  191.  
  192.       -P{p|e|f} (print Pitch)
  193.       Selects print pitch :
  194.  
  195.           -Pp pica
  196.           -Pe eelite
  197.           -Pf fine
  198.  
  199.       Default value : "Pitch" set up in Preferences.
  200.  
  201.       -Spages (Selection)
  202.       Selects the pages to print. "pages" can be one of :
  203.  
  204.           x       only page x
  205.           e       even pages
  206.           o       odd pages
  207.           x-y      from page x to y
  208.           x,y,z,  pages x,y,z,... (up to 16 pages)
  209.  
  210.       You can  also  use  the  two    last  forms  together,    as  in
  211.       "-S1,3,5-8" or "-Se,1,3".
  212.  
  213.       CAUTION:  the  page  numbers    that  you  specify  for   page
  214.       selection must depend of  the  first    page  number  (see  -N
  215.       option)
  216.  
  217.       -X (eXpress) Sets "eXpress" mode (see section  3.2  for  further
  218.       information).
  219.  
  220.       If you make an error in your command line, a window will  appear  on
  221.   the Workbench screen, with the message "Bad arguments". Click  in  the  "OK"
  222.   gadget to make the window disappear, and correct your  command  line.  Then,
  223.   run APrf once more.
  224.       The  "Tools"  menu  has  a  command  that  gives  the  command  line
  225.   corresponding to the current option settings (see section  2.5  for  further
  226.   information).
  227.  
  228. Running_from_Workbench
  229.  
  230.       There's three ways to run  APrf  from  Workbench,  if  you  want  to
  231.   specify the files that hare to be printed:
  232.  
  233.       - by double-clicking on a "Project" icon whose "Default  tool"  is
  234.     APrf
  235.       - by clicking on one or more file icons, holding    down  the  SHIFT
  236.     key, and double-clicking on APrf icon
  237.       - by clicking on APrf icon (and if required on some  file  icons),
  238.     holding down the SHIFT key, and double-clicking on a file icon
  239.  
  240.       In any case, the selected files are transmitted to APrf. The program
  241.   will display the first filename in the "File to print" gadget  (see  section
  242.   2.4). The "Next file" command in the "Project" menu allows you  to  skip  to
  243.   the next file (see section 2.5), and the "Default options"  command  in  the
  244.   "Tools" menu allows to go back to the first file  in  the  files  list  (see
  245.   section 2.5).
  246.  
  247.       As when you run APrf from the CLI, you can give  some  arguments  to
  248.   modify default options. To do this, click on a  file    icon  and  select  the
  249.   "Information" item in the "Icons" menu (on Workbench screen). Then click  on
  250.   the "New" gadget in the "TOOL TYPES" field, and add the arguments  according
  251.   to the following syntax:
  252.  
  253.       APRF=[-c#][-f#,#][-l#][-n#][-oF][-p#][-r#][-s#][-t#][-x#]
  254.       [-Cseq][-D#][-F{L|C|R}fmt][-H{L|C|R}fmt][-Ifont]
  255.       [-N#][-Oopts][-P{p|e|f}][-Spages]
  256.  
  257.       These options are described in section 2.1. If  you  run  APrf  from
  258.   Workbench without arguments (i.e. if you just click twice  on  APrf's  icon)
  259.   options will be taken from "TOOL TYPES" field of APrf's project icon. Please
  260.   notice that -A (AREXX mode) and -X (eXpress mode) options can't be specified
  261.   when running APrf from Workbench.
  262.  
  263.  
  264.  
  265. Getting_started
  266.  
  267.       APrf needs "reqtools.library" v2.0c, so you must  copy  it  in  your
  268.   "LIBS:" directory (if not yet done) before trying to run this program.
  269.       If all goes well, a new  screen  will  be  opened,  and  you'll  see
  270.   several gadgets. The AREXX port is also opened (see section 3.3). Under  2.0
  271.   system release, APrf will always open the application  window  (see  section
  272.   3.4).
  273.       Otherwise, a window will appear on Workbench screen with  a  message
  274.   telling you what problem occurred. Click in the  "OK"  gadget  to  make  the
  275.   window disappear, APrf stops and returns a value  of    10  (ERROR,  see  "IF"
  276.   command of AmigaDOS).
  277.  
  278.       APrf can return a value of 10 without  displaying  any  message,  in
  279.   only three situations:
  280.  
  281.       - APrf couldn't open "reqtools.library"
  282.       - APrf couldn't open the error window
  283.       - APrf couldn't open the Workbench screen
  284.  
  285.       Now, I will suppose that APrf is running  well.  The    two  following
  286.   sections are going describe the gadgets and menus of APrf. If you are  using
  287.   APrf for the first time I suggest to run the program, in order to understand
  288.   these explanations.
  289.  
  290. Gadgets
  291.  
  292.       This section describes all the gadgets displayed on the screen, from
  293.   the left top corner to the right bottom one:
  294.  
  295.       File to print
  296.  
  297.       This gadget shows the name of the file to print.
  298.       To modify its value just click on  it:  a  file  requester  will
  299.       appear. If you click on the CANCEL gadget of this requester,    or
  300.       on the OK gadget without giving a file name, the  previous  name
  301.       won't be modified.
  302.       A '*' character will appear on the right of the file name,  when
  303.       the file is loaded in memory (see section 4.1).
  304.  
  305.       Output file
  306.  
  307.       This gadget shows where a file will be printed.
  308.       Default value is "PRT:", but can be changed with -o option  (see
  309.       section 2.1).
  310.       To modify its value just click on  it:  a  file  requester  will
  311.       appear. If you click on the CANCEL gadget of this requester  the
  312.       output file will become "PRT:".
  313.  
  314.       Page selection
  315.  
  316.       This gadget shows which pages will be printed.
  317.       Default value is "*" (all the pages), but can be changed with -S
  318.       option (see section 2.1).
  319.       Please refert to section 2.8 to see how to modify the selection.
  320.  
  321.       The nine next gadgets allow to specify respectively: the left margin
  322.   size, the right margin size, the tabulation size, the number    of  lines  per
  323.   page, the first page number, the line numbers size, the number  of  columns,
  324.   the column spacing, and the number of copies that have to be printed.
  325.       Each gadget shows the current value of its corresponding  parameter.
  326.   You can click on the value to modify it with the keyboard (press Amiga-X  to
  327.   erase the old value, don't forget  to  press  RETURN  to  validate  the  new
  328.   value). You can also increase the current value by clicking on the up arrow,
  329.   and decrease it by clicking on the down arrow. If a  value  doesn't  change,
  330.   you have reached the lower or the higher limit ! As long  as    you  keep  the
  331.   left mouse button down, the value will be increased or decreased.
  332.  
  333.       Left margin: (see -l option in section 2.1)
  334.       Default value: 0
  335.       Lowest value : 0
  336.       Highest value: 999
  337.  
  338.       Right margin: (see -r option in section 2.1)
  339.       Default value: 0
  340.       Lowest value : 0
  341.       Highest value: 999
  342.  
  343.       Tabulation: (see -t option in section 2.1)
  344.       Default value: 8
  345.       Lowest value : 1
  346.       Highest value: 999
  347.  
  348.       Page length: (see -p option in section 2.1)
  349.       Default value: "Paper length" set up in Preferences
  350.       Lowest value : 5
  351.       Highest value: 999
  352.  
  353.       First page number : (see -N option in section 2.1)
  354.       Default value: 1
  355.       Lowest value : 1
  356.       Highest value: 899
  357.  
  358.       Page selection will be lost each time you will change the
  359.       first page number.
  360.  
  361.       Line numbers : (see -n option in section 2.1)
  362.       Default value: 0 (no line numbers)
  363.       Lowest value : 0 (no line numbers)
  364.       Highest value: 10
  365.  
  366.       Columns: (see -c option in section 2.1)
  367.       Default value: 1
  368.       Lowest value : 1
  369.       Highest value: 999
  370.  
  371.       Col. Spacing: (see -s option in section 2.1)
  372.       Default value: 1
  373.       Lowest value : 1
  374.       Highest value: 999
  375.  
  376.       Copies : (see -x option in section 2.1)
  377.       Default value : 1
  378.       Lowest value : 1
  379.       Highest value : 999
  380.  
  381.       The four next gadgets are used to choose a  value  between  severals
  382.   one. Use the arrow-like gadget at the right of the value to  change  it.  If
  383.   you hold down one of the SHIFT keys when selecting the  gadget,  the    values
  384.   will change in reverse order.
  385.  
  386.       Print pitch
  387.  
  388.       This gadget indicates print pitch. Default  value  is  taken
  389.       from "Pitch" set up in Preferences, but can be changed  with
  390.       -P option (see section 2.1).
  391.  
  392.       Font
  393.  
  394.       This gadget indicates the internal font to use. Usually it's
  395.       the defaut font, but this can be changed with -I option (see
  396.       section 2.1). For more information, see section 3.5.
  397.  
  398.       Date format
  399.  
  400.       This gadget shows the date format in the header (see section
  401.       2.6). By default, the format is  the    AmigaDOS  format,  but
  402.       this can be changed with -D option (see section 2.1).
  403.  
  404.       Page format
  405.  
  406.       This gadget shows the  selected  page  format  (see  section
  407.       2.6). By default, the format is "header", but  this  can  be
  408.       changed with -f option (see section 2.1).
  409.  
  410.       on
  411.  
  412.       This gadget shows on which pages header and/or  footer  will
  413.       be printed (see section 2.6) By default, its value  is  "all
  414.       pages", but this can be changed with -f option (see  section
  415.       2.1).
  416.  
  417.       The next gadgets allows you  to  personnalize  the  header  and  the
  418.   footer.
  419.  
  420.       Header
  421.  
  422.       This gadget shows the format    of  the  three    parts  of  the
  423.       header : the left part, the  central    part,  and  the  right
  424.       part. Default value of each part  can  be  changed  with  -H
  425.       option (see section 2.1).
  426.       To modify the value of any part just click on it : a    window
  427.       with a string gadget will appear.  Press  Amiga-X  to  erase
  428.       current value, RETURN to validate, or click  on  the    window
  429.       close gadget to abort.
  430.       For more information, see section 2.6
  431.  
  432.       Footer
  433.  
  434.       Same as header gadgets, but for the footer. Default value of
  435.       each part can be changed with -F option (see section 2.1).
  436.       For more information, see section 2.6
  437.  
  438.       The two diamond-shaped gadgets on the bottom of  the    screen    allows
  439.   you to start printing (left gadget) or  previewing  (right  gadget)  without
  440.   having to play with the menus.
  441.       You can also click on the main window's  close  gadget  (upper  left
  442.   corner) to quit the program, or on the "zoom" gadget  (upper  right  corner,
  443.   under 2.0 system release only) to iconify APrf.
  444.  
  445. Menus
  446.  
  447.       APrf has three menus: "Project", "Tools" and "Options". Each command
  448.   can be selected by mouse or by a keyboard shortcut, but "Options" menu items
  449.   must be selected by mouse. Here are the options of the Project" menu:
  450.  
  451.       Next file (Amiga-N)
  452.  
  453.       If you have run APrf from  Workbench    and  selected  several
  454.       icons, this command allows you to skip to the next  file  in
  455.       the list of selected files. The "File to  print"  gadget  is
  456.       updated (see section 2.4), and the old file is removed  from
  457.       memory (if it had been loaded, see section 4.1).
  458.  
  459.       Print (Amiga-P)
  460.  
  461.       Start printing.
  462.  
  463.       Palette...
  464.  
  465.       Allows to modify APrf  screen's  colors.  To  save  the  new
  466.       palette immediatly, select the  "Save  config"  command  and
  467.       enter "palette" as a configuration name. Otherwise, when you
  468.       will quit the program, APrf will ask you if you want to save
  469.       the new palette.
  470.  
  471.       About...
  472.  
  473.       Displays some informations about APrf. To close the  window,
  474.       click inside it or press any key.
  475.  
  476.       Iconify (Amiga-I)
  477.  
  478.       APrf goes sleeping, freeing at least 32 Kb  of  CHIP    memory
  479.       and some other workspace (the current file is  removed  from
  480.       memory if it had been loaded). The  screen  is  closed  and,
  481.       under 1.3 system release, a  small  window  which  title  is
  482.       "APrf2 v2.10" will appear on the  top  left  corner  of  the
  483.       Workbench's  screen.   Under   2.0   system   release,   the
  484.       application window remains  opened.  In  both  cases,  AREXX
  485.       messages are still waited for.
  486.       To awake APrf, you must activate this window and click  then
  487.       on the right mouse button. You can quit APrf without    having
  488.       to awake it by clicking on the close    gadget    of  the  small
  489.       window.
  490.  
  491.       Quit (Amiga-Q or ESCAPE)
  492.  
  493.       Quit APrf.  A  requester  will  apear:  click  on  "YES"  to
  494.       confirm, or on "NO" to cancel.
  495.  
  496.   Here are the commands of the "Tools" menu:
  497.  
  498.       Default Options (Amiga-D)
  499.  
  500.       Restores the default options    (first  it  loads  Preferences
  501.       then it scans the command line). If you have run  APrf  from
  502.       Workbench and selected several icons, the first file of  the
  503.       list becomes the file that will be printed.
  504.       This command may be useful, for example, if you  modify  the
  505.       Preferences settings and want APrf to know about it, without
  506.       having to quit the program.
  507.  
  508.       Load file (Amiga-L)
  509.  
  510.       Loads immediately the file to print in memory. If  the  file
  511.       was already in memory,  yet  this  command  reload  it  (see
  512.       section 4.1).
  513.  
  514.       Unload file (Amiga-U)
  515.  
  516.       Removes the file to print from memory (see section 4.1).
  517.  
  518.       Preview (Amiga-V)
  519.  
  520.       Activates the preview function (see section 2.7).
  521.  
  522.       Command line (Amiga-K)
  523.  
  524.       Displays the argument list that you have to give in order to
  525.       make the current options  beeing  the  default  options.  To
  526.       close the window, click inside it or press any key.
  527.  
  528.       Save config (Amiga-S)
  529.  
  530.       Save the current options (except the name  of  the  file  to
  531.       print) in a new line of the  "S:APrf.Init"  file.  A  window
  532.       appears,  and  you  must  enter  the     name    of   the   new
  533.       configuration. Close the window to cancel the operation. See
  534.       section 3.5 for other informations.
  535.  
  536.       Doc Info (Amiga-X)
  537.  
  538.       Displays the page, line and character counts of  the    output
  539.       file. Please notice that the character count will always  be
  540.       an approximation. To close the window,  click  on  the  "OK"
  541.       gadget.
  542.  
  543.   Here are the items of the "Options" menu:
  544.  
  545.       Letter
  546.  
  547.       Selects the printing quality: "letter" or  "draft".  Default
  548.       value is taken from "Print Quality" set up  in  Preferences,
  549.       but can be changed with -O option (see section 2.1).
  550.  
  551.       8 LPI
  552.  
  553.       Selects line spacing: "8LPI" or  "6PLI".  Default  value  is
  554.       taken from "Spacing" set  up  in  Preferences,  but  can  be
  555.       changed with -O option (see section 2.1).
  556.  
  557.       Fanfold
  558.  
  559.       Selects paper type: "fanfold" or "single". Default value  is
  560.       taken from "Pitch" set up in Preferences, but can be changed
  561.       with -O option (see section 2.1).
  562.  
  563.       Truncate
  564.  
  565.       If active, too long lines are  truncated  instead  of  being
  566.       wrapped on several lines. By default, it is not active,  but
  567.       this can be changed with -O option (see section 2.1).
  568.  
  569.       CTRL filter
  570.  
  571.       If active, the control characters (ASCII code lower than  32
  572.       or greated than 126) found in the file to print are not send
  573.       to the printer. By default, it is not active, but  this  can
  574.       be changed with -O option (see section 2.1).
  575.  
  576.       ANSI filter
  577.  
  578.       If active, the ANSI sequences described in section 6 are not
  579.       send to the printer. By default, it is not active, but  this
  580.       can be changed with -O option (see section 2.1).
  581.  
  582.       Buffer 1Kb
  583.  
  584.       If active, the output buffer size will be 1 Kb  (instead  of
  585.       one page). By default, it is not active,  but  this  can  be
  586.       changed with -O option (see section 2.1).  See  section  4.2
  587.       for more information.
  588.  
  589.       Send FF
  590.  
  591.       If active, a "Form Feed" character is  send  each  time  the
  592.       bottom of the page is reached. By default, it is active, but
  593.       this can be changed with -O option (see section 2.1).
  594.  
  595.       Und. header
  596.  
  597.       If active, the header will be underlined. By default, it  is
  598.       not active, but this can be  changed    with  -O  option  (see
  599.       section 2.1).
  600.  
  601. Header_and_footer
  602.  
  603.       APrf can add a header, a footer, or both,  on  your  documents.  The
  604.   choice can be made when calling APrf (-f option, see section  2.1)  or  with
  605.   the "Page format" gadget (see section 2.4). A header or a  footer  takes  to
  606.   line on the page.
  607.       When you ask for a header (and/or a footer) format,  APrf  uses  the
  608.   values of the "Header"  (and/or  "Footer")  gadgets  to  build  this  header
  609.   (and/or footer). The left gadget shows what will be on the left, the central
  610.   gadget what will be centered, and the right  gadget  what  will  be  on  the
  611.   right. Format specifications can include the following sequences :
  612.  
  613.       %a  name of the day (e.g. "Monday")
  614.       %b  name of the month (full, e.g. "September")
  615.       %B  name of the month (short, e.g. "Sep")
  616.       %d  day of the month (01 to 31)
  617.       %D  date as shown by the "Date format" gadget
  618.       %f  basename of the file (e.g. "foo")
  619.       %F  full name of the file (e.g. "RAM:Test/foo")
  620.       %h  hour (00 to 11)
  621.       %H  hour (00 to 23)
  622.       %m  month of the year (01 to 12)
  623.       %M  minutes (00 to 59)
  624.       %n  page number
  625.       %p  period of the day (AM or PM)
  626.       %s  file size in bytes
  627.       %S  seconds (00 to 59)
  628.       %v  program release (e.g. "APrf v4.10")
  629.       %w  day of the week (0 to 6)
  630.       %x  copy number
  631.       %y  year of the century (00 to 99)
  632.  
  633.       Default value for header is "%f" for the left part,  "Page  %n"  for
  634.   the central part, and "%D" for the right part. Default value for  footer  is
  635.   "Page %n" for the central p art, and nothing for the other  parts.  You  can
  636.   also specify your own header (and/or footer)  format,  by  clicking  on  the
  637.   gadget corresponding to the part you want to modify, or (when starting APrf)
  638.   with -H (and/or -F) option : "-HLformat" modifies left part of  the  header,
  639.   "-HCformat" modifies central part, and "-HRformat" modifies right part.
  640.       Last, you can select on which pages you want header and/or footer to
  641.   be printed, by clicking on the "on" gadget (see  section  2.4)  or  with  -f
  642.   option (see section 2.1).
  643.  
  644. The_preview_function
  645.  
  646.       This function allows    you  to  see  the  final  aspect  of  a  text,
  647.   depending upon the current option settings. To use it,  first  set  up  your
  648.   printing settings, then choose the "Preview" command from the "Tools"  menu.
  649.   A window will appear in the middle of your screen, and shows how  will  look
  650.   the first selected page (window size is shaped by the page  size).  To  look
  651.   the next page, click inside the window or press RETURN. To  stop,  click  on
  652.   the window's close gadget or press ESCAPE.
  653.       Please note that APrf won't be able to open the  preview  window  if
  654.   page length value is very high : highest value for page length is  93  lines
  655.   in NTSC mode (122 in PAL mode).
  656.  
  657. Modifying_page_selection
  658.  
  659.       To modify page selection, click on the "Selected  pages"  gadget:  a
  660.   window will appear in the midle of the  screen,  showing  a  grid  with  one
  661.   hundred numbers, each number corresponding to a page number.    These  numbers
  662.   are written on a white background if the corresponding page is selected,  or
  663.   on a blue background if not.
  664.       If you click on a number, you will  change  the  selection  for  the
  665.   corresponding page. You can also use the following gadgets:
  666.  
  667.       ALL          select all pages
  668.       INVERT      reverse selection
  669.       NONE          no page selected
  670.       OK          accept new selection (or RETURN)
  671.       UNDO          undo all changes (takes back old selection)
  672.       CANCEL      abort modification (or ESCAPE)
  673.  
  674.       There's also a string gadget, in which you  can  enter  a  selection
  675.   specification. This new selection will be added to the current  one.    Licits
  676.   values for the string are:
  677.  
  678.       *          all the pages
  679.       x          page x only
  680.       e          even pages
  681.       o          odd pages
  682.       x-y          from page x to y
  683.       x,y,z,...   pages x,y,z,...
  684.  
  685.       You can also use the two last  forms    together,  e.g.  "1,3,5-8"  or
  686.   "e,1,3".
  687.  
  688.       Don't forget that page selection depends of the first  page  number,
  689.   and that you won't be allowed to enter an empty selection (that is, with  no
  690.   page selected).
  691.  
  692. Using_powerpacker.library
  693.  
  694.       APrf can use "powerpacker.library" according you have  installed  it
  695.   in the "LIBS:" directory of your hard disk or Workbench  disk.  This  allows
  696.   you to print any files compressed with "PowerPacker  2.3b"  or  "PowerPacker
  697.   Pro 3.0b": the file will be decompressed automatically at loading.  If  data
  698.   file has been encrypted, APrf will ask for a password.
  699.  
  700. The_eXpress_mode
  701.  
  702.       It can happen that you want to print a file quickly,    without  using
  703.   the Intuition interface (if your Preferences are correctly set, it should be
  704.   frequent). If you specify -X option when calling APrf, once the command line
  705.   has been parsed, printing starts immediatly. APrf doesn't open  any  screen,
  706.   and stops when printing is done. Error messages are displayed in  a  special
  707.   window, on WorkBench's screen.
  708.  
  709. The_AREXX_mode
  710.  
  711.       When starting, APrf always open an  AREXX  compatible  port,    nammed
  712.   "APrf_rexx", and waits for messages on this port. Valid messages are :
  713.  
  714.       quit      APrf closes the message port and terminates.
  715.       wakeup  APrf closes the message port and open its screen.
  716.       reset   APrf loads Preferences and sets all options to their
  717.           default values
  718.       load      APrf loads the file to print
  719.       print   APrf starts printing
  720.  
  721.       Any other message will be considered as a command line,  and    scaned
  722.   as described in section 2.1. If  any    error  occurs,    APrf  will  display  a
  723.   message on the WorkBench's screen, and terminates.  If  you  send  a  "load"
  724.   message and APrf don't know which file is to load, your command  won't  have
  725.   any effect.
  726.  
  727.       Here    is  an     exemple   of    AREXX    program,   which   print   the
  728.   "S:Startup-Sequence"  file  with  a  left  margin  of  10  characters,   and
  729.   terminates APrf :
  730.  
  731.       /* Print S:Startup-Sequence */
  732.       ADDRESS "APrf_rexx"
  733.       "S:Startup-Sequence -l10"
  734.       "print"
  735.       "quit"
  736.  
  737.       Please note the " characters arround commands !
  738.       If you specify -A option when calling APrf,  it  will  go  in  AREXX
  739.   mode: only  the  application    window    (under  2.0  system  release)  or  the
  740.   iconification window (under 1.3 system release) is opened, and  the  program
  741.   works the same way as when iconified. From the Intuition interface  you  can
  742.   go in AREXX mode just by selecting the "Iconify" command  in  the  "Project"
  743.   menu (see section 2.5).
  744.  
  745. The_Application_Window
  746.  
  747.       When running under 2.0 system release, APrf automatically  opens  an
  748.   application window (also called "AppWindow") on the Workbench  screen.  Then
  749.   you will have the following possibilities:
  750.  
  751.       - if you select one or  several  icons  and  drop  them  over  the
  752.     application window, APrf will eventually open it's  screen,  put
  753.     it to front, and you will be able to print the file(s) as if you
  754.     started the program from Workbench.
  755.       - if you click on the close gadget of the application window,  the
  756.     program will stop running (no confirmation in AREXX mode)
  757.       - if you activate the application window and click on right  mouse
  758.     button, APrf will open it's screen and normal interface will  be
  759.     accessible (same as sending "wakeup" command from AREXX)
  760.       - to save the current size and position of the application window,
  761.     enter "appwin"  as  a  configuration  name  (see  "Save  config"
  762.     command in section 2.5)
  763.  
  764.       Take notice that the application window replaces  the  iconification
  765.   window.
  766.  
  767. The_APrf.Init_file
  768.  
  769.       When starting, APrf tries to load the "S:APrf.Init" file. This  file
  770.   allows you to define    typical  configurations  and/or  fonts.  To  define  a
  771.   typical configuration, you add a line of the form:
  772.  
  773.       name:options:sequence
  774.  
  775.   where "name" and "options" are strings of characteres ("name"  shouldn't  be
  776.   longer than 8 characters),  and  "sequence"  is  a  list  of  decimal  codes
  777.   separated by spaces. "options" and/or "sequence" strings may be empty.  Only
  778.   the 8 first configurations will be used. Here are two examples:
  779.  
  780.       my8lpi:-p90 -O8:
  781.       landscap:-p80:27 48 108 72
  782.  
  783.       Each name you gave will appear in  a    new  "Control"  menu.  If  you
  784.   select one of these names, the "options" string will immediatly be parsed as
  785.   a CLI command line. Also, at printing time, the characters whose ASCII  code
  786.   is given in the corresponding sequence will be send to  the  printer    (after
  787.   the initialisation sequences, but before the text itself).  You  can    select
  788.   several names at the same time.
  789.       When calling APrf from the CLI or from the WorkBench, the -C    option
  790.   allows you to select a sequence at startup time. The "option" string will be
  791.   parsed after the other calling options. If the sequence you specified in the
  792.   -C option doesn't exist, the option will be ignored.
  793.  
  794.       The "S:APrf.Init" file can also give you access, from APrf,  to  the
  795.   internal fonts of your printer. To define a font, you  add  a  line  of  the
  796.   form:
  797.  
  798.       fontdef:name:sequence
  799.  
  800.   where "name" is the name of the font, and "sequence" the list  of  codes  to
  801.   send to your printer to select the given font. Exemple :
  802.  
  803.       fontdef:Prestige:27 107 2 27 120 49
  804.  
  805.   You can enter any number of font. Font definitions should  be  specified  at
  806.   the beginning of the file, before  typical  configurations  definitions.  To
  807.   select a font, use either the -I option (see  section  2.1)  or  the  "Font"
  808.   gadget (see section 2.4).
  809.  
  810.       Another line format allows to  specify  APrf    screen's  colors.  The
  811.   format is:
  812.  
  813.       palette: c1 c2 c3 c4
  814.  
  815.   where "c1", "c2", "c3", "c4" are RGB color specifications. These values  can
  816.   be in decimal or in hexadecimal (in the latter case,  add  "0x"  before  the
  817.   value, like "0x0F00"). If there are several palette specifications, only the
  818.   last will be used.
  819.  
  820.       Last, you can specify the  size  and    position  of  the  application
  821.   window (under 2.0 system release only) with a line of the form:
  822.  
  823.       appwin: x y w h
  824.  
  825.   where "x" and "y" are the position of the upper left corner, "w"  the  width
  826.   and "h" the height of the window. There is no check upon these values, if an
  827.   error occurs the window won't be opened.
  828.  
  829.       You can  put    empty  lines  in  the  "S:APrf.Init"  file.  Any  line
  830.   beginning with a semicolon character (";") is supposed to be a  comment  and
  831.   is not interpreted.
  832.       The "S:APrf.Init" file will be loaded again each time you select the
  833.   "Default options" command in  the  "Tools"  menu.  In  "eXpress"  mode  (see
  834.   section 3.2), the file "S:APrf.Init" will be loaded only if  required  (i.e.
  835.   if you specified a -C or a -I option). Take notice that the  sequences  will
  836.   be written with a PRD_RAWWRITE command, so they won't be interpreted by  the
  837.   printer device.
  838.  
  839. Memory_management
  840.  
  841.       Before printing or previewing a file, APrf loads it in memory.  Once
  842.   the file has been printed or previewed, it is kept in memory in prevision of
  843.   another print or preview operation. The great advantage is that APrf has not
  844.   to load a file each time you ask for previewing it,  or  when  you  ask  for
  845.   printing it after a preview.
  846.  
  847.       A file is removed automatically from memory either  if  you  iconify
  848.   APrf (see section 2.5), or if you choose to print another file (see  section
  849.   2.4), or if you select the "Next file" command from the "Project" menu  (see
  850.   section 2.5). It can be removed too (but  not  always)  if  you  select  the
  851.   "Default options" command from the "Tools" menu.
  852.       In addition, the "Load file" command from the "Tools" menu  enforces
  853.   APrf to load a file (this will  be  reloaded  even  if  it  was  already  in
  854.   memory), while the "Unload file" command in the "Tools" menu makes  APrf  to
  855.   unload a file from memory.
  856.       To let you know if a    file  is  or  isn't  loaded  in  memory,  APrf
  857.   displays a "*" character on the right of the file name  when  this  file  is
  858.   actually loaded in memory.
  859.  
  860.       This behaviour can present two inconvenients. First of all,  a  file
  861.   occupies memory even if you don't need it anymore. A solution is to  iconify
  862.   APrf (see section 2.5) or to select  the  "Unload  file"  command  from  the
  863.   "Tools" menu.
  864.       The second inconvenient is that if you modify a file on  your  disk,
  865.   any changes could be ignored, because APrf don't load  the  file  again.  In
  866.   order to avoid this, if APrf sees that the file has been modified,  it  will
  867.   ask you if you want to reload it.
  868.  
  869. The_output_buffer
  870.  
  871.       APrf uses an output buffer in order to make less  "write"  commands.
  872.   With a 1 Kb buffer, printing to a file is twice faster than with  the  first
  873.   releases of APrf whose buffer contained only one line. Even if  printing  to
  874.   printer doesn't seem to be faster, the number of "write" commands is divided
  875.   at least by 5 (at most by 14 or 15). Tests have shown that system charge was
  876.   greatly reduced, and that THE OTHER TASKS WERE LESS SLOWED DOWN.
  877.       By default, APrf uses an output buffer of one page (see section 2.5,
  878.   "Buffer" option from the "Options" menu). When you change  your  page  size,
  879.   the output buffer is automatically re-allocated in order to  store  a  whole
  880.   page. If there's not enough memory to allocate this one  page  buffer,  APrf
  881.   will try to allocate a 1 Kbytes buffer (a  message  will  inform  you  about
  882.   this). If there's still not enough memory, APrf  will  stop  with  an  error
  883.   message "Not enough memory".
  884.  
  885. Miscellaneous
  886.  
  887.       This section is a bric-a-brac of some informations that didn't  find
  888.   a  place  in    previous  sections.  It  deals    with  some  importants    points
  889.   concerning how APrf works. I strongly advise you to read it  once  at  least
  890.   and to remind to read it again if you think APrf is working oddly.
  891.  
  892.       If "Fanfold" option is not activated, here is the behaviour of APrf:
  893.   before printing a page, the program  displays  a  requester  asking  you  to
  894.   insert a new sheet of paper in your printer. When  you're  ready,  click  on
  895.   "YES" to print the page. If you click on "NO" printing will be aborted.
  896.  
  897.       You can abort printing at any time, by clicking in the box where the
  898.   current copy and page numbers are displayed. A requester will appear, asking
  899.   you confirmation: click on "YES" to stop  printing  and  click  on  "NO"  to
  900.   resume printing. If you abort printing, APrf will immediatly    stop  to  send
  901.   data to the printer, and wait for the last  write  request  to  be  finished
  902.   (this can be quite long !).
  903.  
  904.       To make your files have  a  better  looking,    you  can  include  the
  905.   following ANSI sequences:
  906.  
  907.       ESC[0m  Normal character set
  908.       ESC[3m  Italics on
  909.       ESC[23m Italics off
  910.       ESC[4m  Underline on
  911.       ESC[24m Underline off
  912.       ESC[1m  Boldface on
  913.       ESC[22m Boldface off
  914.       ESC[1"z Draft quality
  915.       ESC[2"z NLQ quality
  916.  
  917.   All these sequences will be sent to your printer, but  the  characters  that
  918.   compose them will neither be retained, nor be  displayed  when  APrf    is  in
  919.   preview mode. Any other  sequences  will  be    not  recognized  and  will  be
  920.   considered as part of text to be printed. You can filter these sequences  if
  921.   you don't want them to be send  to  the  printer  (see  section  2.5,  "ANSI
  922.   filter" item in "Options" menu).
  923.       The size of these sequences is limited to 32    characters  by    OUTPUT
  924.   line (not input line  !),  i.e.  to  6  or  8  sequences,  which  should  be
  925.   sufficient in most case. If there's too much sequences on  an  output  line,
  926.   the error message "Lines too long, printing aborted" will be displayed.
  927.  
  928.  
  929.  
  930.  
  931.  
  932. 2.1 alias Running_from_CLI
  933. 2.2 alias Running_from_Workbench
  934. 2.3 alias Getting_started
  935. 2.4 alias Gadgets
  936. 2.5 alias Menus
  937. 2.6 alias Header_and_footer
  938. 2.7 alias The_preview_function
  939. 2.8 alias Modifying_page_selection
  940. 3.1 alias Using_powerpacker.library
  941. 3.2 alias The_eXpress_mode
  942. 3.3 alias The_AREXX_mode
  943. 3.4 alias The_Application_window
  944. 3.5 alias The_APrf.Init_file
  945. 4.1 alias Memory_management
  946. 4.2 alias The_ouput_buffer
  947. 5   alias Miscellaneous
  948.  
  949.  
  950.  
  951.